BOT UX API

(0 reviews)

Post TopUpBalance

This operation creates and provides Topup Balance Info for resources with operations that allow fetching of Prepay Balance.

URL

http://[host]:[port]/bot-ux/v1/{businessId}/topupBalance

Common Parameters

Base URI Parameter

Note: JM and BTC has actual Implementation and other BUs has Stub Implementation

Name	Type	M/O	Description
businessId	string	M	JM

Headers

name	value	description	required
X-Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	M
lob	string	Enum: PREPAID, POSTPAID,FIXED Note : Mobile users: PREPAID, POSTPAID Fixed users : FIXED	M

Security Headers

Name	Type	M/O	Description
client_id	string	M	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332
client_secret	string	M	Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a

Request Body

{
    "voucher": "89742282598199",
   "amount": {
       "amount": 1,
       "units": "JMD"
      },
   "partyAccount": {
           "id": "18763187057",
           "@type": "subscriberNumber"
        },
    "bucket":{
        "id": "1",
        "href": "https://esb-dev.lla.com/prepayBalanceManagement/v4/bucket/1",
        "description": "Primary Balance",
        "name": "Primary Balance",
        "@baseType": "BucketBalance",
        "@type": "Core",
    }
}

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

TMF Response for post topUpBalance

JM Response

{
    "description": "Primary Balance",
    "voucher":"89742282598199",
    "amount": {
        "amount": 5.00,
        "units": "JMD"
    },
    "bucket": {
        "id": "1",
        "href": "https://esb-dev.lla.com/prepayBalanceManagement/v4/bucket/1",
        "description": "Primary Balance",
        "name": "Primary Balance",
        "@baseType": "BucketBalance",
        "@type": "Core",
        "usageType": "Currency",
        "remainingValue": {
            "amount": 8.00,
            "units": "JMD"
        },
        "remainingValueName": "Primary Balance",
        "validFor": {
            "endDateTime": "2022-03-01T00:00:00.000-05:00"

        }
    },
    "ImpactedBucket": [
    {
            "amountAfter": {
                "amount": 25.59,
                "units": "JMD"
            },
            "amountBefore": {
                "amount": 22.59,
                "units": "JMD"
            },
            "name": "Primary Balance",
            "@type": "Core"
        },
    {
            "amountAfter": {
                "amount": 0.00,
                "units": "JMD"
            },
            "amountBefore": {
                "amount": 2.00,
                "units": "JMD"
            },
            "name": "Loan Balance",
            "@type": "Loan"
        },
    ]
}